此次 Django REST framework 預計會做一個簡單的 RESTful API,包含基本的 User,使用 Token Authentication。端點的話預計用 books 當作資源,並用 HTTP verb 進行操作。此外 API 也會有圖片上傳功能。
這邊創建另一個資料夾 api_project,進入後創建虛擬環境。接著啟動虛擬環境,來安裝其他東西!我自己會創建一個requirements.txt
檔,裡面包含所有需要的套件及版本,這樣別人拿取專案時就可以用這個檔案一次安裝所有套件,挺方便的。首先,先新增該檔案,Windows 的指令如下:
type nul > requirements.txt
MacOS 或 Linux 指令則是:
touch requirements.txt
接著打開 requirements.txt,加入此次所需的套件及相關版本:
Django==4.1.7
djangorestframework>=3.13.1,<3.14
drf-spectacular==0.22.1
pillow==9.1.0
再來輸入指令:
pip install -r requirements.txt
如此便可一次安裝所有套件,很方便吧!!這邊簡單介紹套件:
這次做的跟上個專案不同,所以要在另一個資料夾建立新專案。將 API 專案名取為 rest_api。在虛擬環境中進入 project 資料夾並輸入以下指令:
django-admin startproject rest_api
接著進入專案資料夾並創建 core app
cd rest_api
python manage.py startapp core
接著到settings.py
中新增 core 以及其他套件:
# 其他程式碼
INSTALLED_APPS = [
# 其他 app
'core',
# 以下也一起新增
'rest_framework',
'rest_framework.authtoken',
'drf_spectacular',
]
這樣便完成了基本的設定
接下來會介紹網路中傳遞的資料格式。明天見~